Document deployment.stagingRetention.maxCount and payloadRetention.maxSize - #668
Document deployment.stagingRetention.maxCount and payloadRetention.maxSize#668dawsontoth wants to merge 1 commit into
Conversation
…xSize Adds a deployment section to the configuration reference for the two retention knobs, and a 5.3 release note for staged build retention (HarperFast/harper#2315 step 4). Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request documents the new deployment configuration options (payloadRetention.maxSize and stagingRetention.maxCount) and updates the v5.3 release notes to detail the staged build retention feature. The feedback suggests formatting adjustments to adhere to style guidelines, including using hyphens instead of em dashes as field separators in the configuration options documentation, and removing direct links to internal GitHub issues in the user-facing release notes.
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-668 This preview will update automatically when you push new commits. |
| maxCount: 5 | ||
| ``` | ||
|
|
||
| - `payloadRetention.maxSize` — Bytes. After a successful deploy, a payload larger than this has its stored tarball (`payload_blob`) dropped from the `hdb_deployment` row; the row and its metadata stay. Set it very high to retain every payload; _Default_: `10485760` (10 MiB) |
There was a problem hiding this comment.
payloadRetention.maxSize is a public configuration surface newly documented here, but unlike the adjacent retention setting it has no VersionBadge. The v5 reference combines minor releases, so users cannot tell whether their installed version accepts this key. Add a badge for its actual shipping minor (use v5.3.0 if it ships with this change).
2 participants
Companion to HarperFast/harper#2531 (step 4 of HarperFast/harper#2315).
Adds a
deploymentsection to the configuration reference covering the newstagingRetention.maxCountknob and the existing but previously undocumentedpayloadRetention.maxSize, and a 5.3 release note for staged build retention.Verified with
npm run format:check; no new pages or links beyond the existingdeploy_componentanchor.